home *** CD-ROM | disk | FTP | other *** search
/ HPAVC / HPAVC CD-ROM.iso / pc / POVHELP.ZIP / povhelp.doc < prev    next >
Encoding:
Text File  |  1994-08-09  |  7.3 KB  |  171 lines
  1.                                  HELP ON HELP
  2.  
  3. Using the Help Reader (POVHELP.EXE)
  4.  
  5. KNOWN INCOMPATIBILITIES
  6.  
  7. POV-Help does not work with MS-DOS's EDIT  program.  [In  fact,  EDIT.COM  is
  8. really QBASIC.EXE with a few add ons ; EDIT needs QBASIC to run.]
  9.  
  10. Quick Intro
  11.  
  12. Use +E option to make the help reader a pop-up program.
  13. Use Space to go to the next section.
  14. Use Ctrl-PgUp and Ctrl-PgDn to move between sections also.
  15. Use Tab to highlight hypertext links.
  16. Use Alt-Tab to highlight code fragments.
  17. Use Enter to jump to a highlighted hypertext link.
  18. Use +/- to jump to relevant sections once link jumping has started.
  19. Use BACKSPACE to return to the last place you were before a search/jump.
  20. Use 'S' to search on a keyword.
  21. Use 'J' to toggle text justification when reading a section.
  22. Use 'P' to paste code into your application via the keyboard buffer.
  23.  
  24. POV-Help will handle non-standard page widths provided the BIOS column  count
  25. is correctly updated by whatever program is being used to alter  it  from  80
  26. columns.
  27.  
  28. If you use POV-Help as a pop-up program, it will attempt  to  search  on  the
  29. word under your cursor when you pop it up. Note that if you exit pop-up  mode
  30. by using the hot-key, POV-Help takes this to mean that you want to return  to
  31. the same place next time and will not perform a  search.  A  search  is  only
  32. performed if you exited using ESCAPE (meaning  you  have  finished  with  the
  33. current subject.)
  34.  
  35. The history stack activated by using Backspace holds 32 entries.
  36.  
  37. The program PHE2TXT.EXE can be used to convert a POV-Help database into ASCII.
  38. Use PHE2TXT -? for help.
  39.  
  40. Command Line (case insensitive)
  41.   +Iname                 use alternate file name (default HELP.PHE)
  42.   +N123                  go to the 123rd section (NOT section 123!)
  43.   +S4.5.6                go to section '4.5.6'
  44.   +Tsphere or "+Tsphere" go straight to the first section found with 'sphere'
  45.                          in its title.
  46.   +W50                   window width 40 characters (max 127)
  47.   +H15                   window height 15 lines (max 21)
  48.   +J[-]                  justify ON (default), -J- to turn off
  49.   +PH[n]                 send 'n' HOME  keys  after  each  CR  when  pasting.
  50.                          default is -ph1.
  51.   +KALT-ESC              hot  key  sequence.  can  be  CTRL|ALT|CTRL-ALT+[Any
  52.                           character]|[ESC].  e.g.   +KCTRL-ALT-P,   +KCTRL-1,
  53.                          +KALT-CTL-'. CTL is also acceptable.
  54.   +Eabc d e              run program 'abc' with parameters 'd' and  'e'.  all
  55.                          parameters after the '+e' are passed to the program.
  56.  
  57.   text                   same as +T unless collecting +E parameters, where it
  58.                          is a parameter
  59.  
  60.  
  61. Viewer Commands Top Menu
  62.   Up, Down move highlight bar
  63.   Enter    view selected item
  64.   Escape   exit help viewer
  65.  
  66.  
  67. Authors, Copyright
  68.   Up, Down    scroll screen
  69.   PgUp, PgDn  scroll screen
  70.   Left, Right scroll screen
  71.   Escape      return to top menu
  72.  
  73.  
  74. Section
  75.   Up, Down          scroll screen
  76.   PgUp, PgDn        scroll screen
  77.   Left, Right       scroll screen
  78.   Escape            return to top menu
  79.   Space or CtrlPgDn view next section
  80.   CtrlPgUp          view previous section
  81.   "+", Enter        jump to first/next hypertext link
  82.   "-"               jump to previous link/original section
  83.   "B"               jump back to original section (from before link  jumping)
  84.  
  85.   Tab               select next visible link, wraps from last to first
  86.   ShiftTab          select previous visible hypertext link
  87.   AltTab            select code fragment for pasting.
  88.   "P"               paste highlighted code fragment via keyboard buffer.
  89.  
  90.  
  91. General
  92.  
  93. The help reader wraps most text. Excluded are specified portions, lists,  and
  94. a few others. Use the left and right arrow keys to scroll these if need be.
  95.  
  96. The help reader is intended to be a 'shell' around an  editor  program.  Some
  97. people may prefer the term 'shim'.
  98.  
  99. Using EMS for most memory requirements, it loads itself and  then  runs  your
  100. editor for you, providing pop-up help facilities. It will  also  be  able  to
  101. paste code fragments into your source. If your editor was, for example, 'ME',
  102. you would place a batch  file  called  'ME.BAT'  in  your  scene  development
  103. directory. If you use 'VI', you'd create 'VI.BAT', and so on.
  104.  
  105. (YOUR-EDITOR-NAME.BAT)
  106.  
  107. desired key sequence ───┐
  108.                         │
  109.         ┌─────────┐ ┌───┴────────┐ ┌──────────────┐
  110. povhelp │+W50 +H15│ │+KCTRL-ALT-H│ │+Ed:\me\me.exe│ %1 %2 %3 %4 %5
  111.         └───────┬─┘ └────────────┘ └───┬──────────┘
  112.                 │                      │
  113. size of window ─┘                      │
  114.                                        │
  115. place path to your editor here ────────┘
  116.  
  117.  
  118. For example -
  119.  
  120. povhelp +W50 +H15 +KALT-H +Ed:\me\me.exe %1 %2 %3 %4 %5
  121.  
  122. This command line will yield a version  of  POV-Help  with  a  50x15  window,
  123. popped-up with the ALT-H key sequence, over the editor 'd:\me\me.exe'. If you
  124. don't specify a key sequence, POV-Help defaults to using ALT-ESC.
  125.  
  126. This would load the help reader. which would then  load  ME.EXE,  and  things
  127. would proceed  as  normal.  When  you  exit  your  editor,  the  help  reader
  128. automatically unloads. You can  use  the  ALT-ESC  key  sequence  to  pop  up
  129. POVHELP. This is the default ; there is a way to set it. Note that  no  other
  130. parameters may appear after the +E parameter as they will just be  passed  to
  131. the program being run.
  132.  
  133. If you use the hotkey to pop-up, POVHELP  performs  a  simplistic  search  of
  134. sections and titles based on the word under the cursor.  If  found,  you  are
  135. taken to that. Otherwise,  you  are  taken  to  the  main  menu,  unless  you
  136. hot-keyed out.
  137.  
  138. You can hot-key out of the actual section text, by using  the  same  hot  key
  139. that got you in. If you press escape, you are taken back up to the top  menu.
  140. But if you hotkey out, you go back to your program. Next time you  press  the
  141. hot key, you will be taken back to the same place. No search is performed  in
  142. this case.
  143.  
  144. POVHELP needs EMS if it is running as a shell program.
  145.  
  146. If you don't specify the +E parameter, POVHELP will come up as a  stand-alone
  147. program, in which case it does not use EMS.
  148.  
  149. If you highlight a section of code using Alt-Tab, and you are using  POV-Help
  150. in pop-up mode, then you may paste the code via  the  keyboard  buffer  using
  151. 'P'.
  152.  
  153. As many editors today use auto-indentation, this may cause some problems with
  154. column alignment. For that reason, POV-Help by default  inserts  a  HOME  key
  155. code into the keyboard buffer after each CR. Some editors require  more  than
  156. one HOME key operation to get to the left column. For this reason, the number
  157. of HOME's sent  may  be  adjusted  from  0  (none)  to  9  using  the  +PH[n]
  158. command-line parameter. 'n' is any value from 0 to 9 and defaults to 1.
  159.  
  160. POV-Help was written by  Christopher J. Cason.
  161. CIS      : 100032,1644.
  162. Internet : cjcason@yarrow.wt.uwa.edu.au.
  163.  
  164. Converters will be available which  translate  POV-Help  databases  to  other
  165. formats such as Postscript, LaTeX, RTF, Windows Help, HTML, etc.
  166.  
  167. The format of the POV-Help database is documented and freely available.
  168.  
  169. POV-Help is free. It may not be  sold.  See  POVLEGAL.DOC  for  details.  The
  170. POV-Help suite of programs is copyright (c) 1994 C.J. Cason and the POV-Team.
  171.